home *** CD-ROM | disk | FTP | other *** search
/ CD BIT 75 / CD BIT 75.iso / Software / ooo / f_0020 / sbasic.jar / text / sbasic / common / 01020300.xml < prev    next >
Encoding:
Extensible Markup Language  |  2003-08-01  |  10.8 KB  |  70 lines
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <html><head><title>Using Procedures and Functions</title><meta name="filename" content="text/sbasic/common/01020300"/><help:css-file-link xmlns:help="http://openoffice.org/2000/help"/><!--The CSS style header method for setting styles--><style type="text/css">
  3.  
  4.         table.Tabelle2{
  5.                 }
  6.         span.Tabelle2A{
  7.                 width:1.499cm;}
  8.         span.Tabelle2B{
  9.                 width:16.501cm;}
  10.         td.Tabelle2A1{
  11.                 }
  12.         p.P1{
  13.                 }
  14.         span.T1{
  15.                 font-weight:bold;}
  16.         span.fr1{
  17.                 }
  18.         </style></head><body>
  19.   
  20.   
  21.   <help:paragraphinfo state="E" xmlns:help="http://openoffice.org/2000/help"/><help:to-be-embedded Eid="prozedur" xmlns:help="http://openoffice.org/2000/help">
  22.   <p class="Head1"><help:paragraphinfo state="U" number="1"/><help:key-word value="procedures; using" tag="kw66513_1"/><help:key-word value="functions; using" tag="kw66513_11"/><help:link Id="66513">Using Procedures and Functions</help:link></p>
  23.   <p class="Paragraph"><help:paragraphinfo state="U" number="2"/>The following describes the basic use of procedures and functions in <help:productname>%PRODUCTNAME</help:productname> Basic.</p>
  24.   <help:paragraphinfo state="E"/></help:to-be-embedded>
  25.   <p class="Paragraph"><help:paragraphinfo state="U" number="3" xmlns:help="http://openoffice.org/2000/help"/>Procedures (SUBS) and functions (FUNCTIONS) help you maintaining a structured overview by separating a program into logical pieces.</p>
  26.   <p class="Paragraph"><help:paragraphinfo state="U" number="4" xmlns:help="http://openoffice.org/2000/help"/>One benefit of procedures and functions is that once you have developed a program code containing task components, you can use this code in other project.</p>
  27.   <p class="Head2"><help:paragraphinfo state="U" number="26" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="variables; passing to procedures and functions" tag="kw66513_10" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="parameters; for procedures and functions" tag="kw66513_9" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="procedures; parameters" tag="kw66513_8" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="functions; parameters" tag="kw66513_7" xmlns:help="http://openoffice.org/2000/help"/>Passing Variables to Procedures (SUB) and Functions (FUNCTION)</p>
  28.   <p class="Paragraph"><help:paragraphinfo state="U" number="27" xmlns:help="http://openoffice.org/2000/help"/>Variables can be passed to both procedures and functions. The SUB or FUNCTION must be declared to expect parameters:</p>
  29.   <p class="PropText"><help:paragraphinfo state="U" number="28" xmlns:help="http://openoffice.org/2000/help"/>SUB SubName(<span class="T1">Parameter1 As Type, Parameter2 As Type,...</span>)</p>
  30.   <p class="PropText"><help:paragraphinfo state="U" number="29" xmlns:help="http://openoffice.org/2000/help"/>Program code</p>
  31.   <p class="PropText"><help:paragraphinfo state="U" number="30" xmlns:help="http://openoffice.org/2000/help"/>END SUB</p>
  32.   <p class="Paragraph"><help:paragraphinfo state="U" number="31" xmlns:help="http://openoffice.org/2000/help"/>The SUB is called using the following syntax:</p>
  33.   <p class="PropText"><help:paragraphinfo state="U" number="32" xmlns:help="http://openoffice.org/2000/help"/>SubName(Value1, Value2,...)</p>
  34.   <p class="Paragraph"><help:paragraphinfo state="U" number="33" xmlns:help="http://openoffice.org/2000/help"/>The parameters passed to a SUB must fit to those specified in the SUB declaration.</p>
  35.   <p class="Paragraph"><help:paragraphinfo state="U" number="34" xmlns:help="http://openoffice.org/2000/help"/>The same process applies to FUNCTIONS. In addition, functions always return a function result. The result of a function is defined by assigning the return value to the function name:</p>
  36.   <p class="PropText"><help:paragraphinfo state="U" number="35" xmlns:help="http://openoffice.org/2000/help"/>FUNCTION FunctionName(Parameter1 As Type, Parameter2 As Type,...) As Type</p>
  37.   <p class="PropText"><help:paragraphinfo state="U" number="36" xmlns:help="http://openoffice.org/2000/help"/>Program code</p>
  38.   <p class="PropText"><help:paragraphinfo state="U" number="37" xmlns:help="http://openoffice.org/2000/help"/><span class="T1">FunctionName=Result</span></p>
  39.   <p class="PropText"><help:paragraphinfo state="U" number="38" xmlns:help="http://openoffice.org/2000/help"/>End Function</p>
  40.   <p class="Paragraph"><help:paragraphinfo state="U" number="39" xmlns:help="http://openoffice.org/2000/help"/>The FUNCTION is called using the following syntax:</p>
  41.   <p class="PropText"><help:paragraphinfo state="U" number="40" xmlns:help="http://openoffice.org/2000/help"/>Variable=FunctionName(Parameter1, Parameter2,...)</p>
  42.   <p class="Head2"><help:paragraphinfo state="U" number="45" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="parameters; pass by reference" tag="kw66513_6" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="parameters; pass by value" tag="kw66513_5" xmlns:help="http://openoffice.org/2000/help"/>Passing Variables by Value or Reference</p>
  43.   <p class="Paragraph"><help:paragraphinfo state="U" number="47" xmlns:help="http://openoffice.org/2000/help"/>Parameters can be passed to a SUB or a FUNCTION either by reference or by value. Unless otherwise specified, a parameter is always passed by reference. That means that a SUB or a FUNCTION gets the parameter and can read and modify its value.</p>
  44.   <p class="Paragraph"><help:paragraphinfo state="U" number="53" xmlns:help="http://openoffice.org/2000/help"/>If you want to pass a parameter by value insert the key word "ByVal" in front of the parameter when you call a SUB or FUNCTION, for example:</p>
  45.   <p class="PropText"><help:paragraphinfo state="U" number="54" xmlns:help="http://openoffice.org/2000/help"/>Result = Function(<span class="T1">ByVal</span> Parameter)</p>
  46.   <p class="Paragraph"><help:paragraphinfo state="U" number="55" xmlns:help="http://openoffice.org/2000/help"/>In this case, the original content of the parameter will not be modified by the FUNCTION since it only gets the value and not the parameter itself.</p>
  47.   <table><tr class=""><th class="Tabelle2A1" style="text-align:left;"><span class="Tabelle2A">
  48.       <p class="TextInTable"><draw:image draw:name="Icon0" svg:desc="This icon marks text containing additional information." svg:pixelx="32" svg:pixely="32" svg:width="0.847cm" svg:height="0.847cm" xlink:href="65980" draw:filter-name="" xmlns:draw="http://openoffice.org/2000/drawing" xmlns:svg="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"/></p>
  49.  
  50.      </span></th><th class="Tabelle2A1" style="text-align:left;"><span class="Tabelle2B">
  51.       <p class="TextInTable"><help:paragraphinfo state="U" number="56" xmlns:help="http://openoffice.org/2000/help"/>When you create a new module, <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> Basic automatically inserts a SUB called "Main". This default name has nothing to do with the order or the starting point of a <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> Basic project. You can also safely rename this SUB.</p>
  52.      </span></th></tr></table>
  53.   <p class="Head2"><help:paragraphinfo state="U" number="57" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="variables; scope" tag="kw66513_4" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="scope; variables" tag="kw66513_3" xmlns:help="http://openoffice.org/2000/help"/>Scope of Variables</p>
  54.   <p class="Paragraph"><help:paragraphinfo state="U" number="58" xmlns:help="http://openoffice.org/2000/help"/>A variable defined within a SUB or FUNCTION, only remains valid until the procedure is exited. This is known as a "local" variable. In many cases, you need a variable to be valid in all procedures, in every module of all libraries, or after a SUB or FUNCTION is exited. This property is controlled in a variable declaration through key words in the <span class="T1">Dim</span> statement.</p>
  55.   <p class="Head3"><help:paragraphinfo state="U" number="59" xmlns:help="http://openoffice.org/2000/help"/>Declaring Variables Outside a SUB or FUNCTION</p>
  56.   <p class="PropText"><help:paragraphinfo state="U" number="111" xmlns:help="http://openoffice.org/2000/help"/>DIM GLOBAL VarName As TYPENAME</p>
  57.   <p class="Paragraph"><help:paragraphinfo state="U" number="112" xmlns:help="http://openoffice.org/2000/help"/>The variable is valid as long as the <help:productname xmlns:help="http://openoffice.org/2000/help">%PRODUCTNAME</help:productname> session lasts.</p>
  58.   <p class="PropText"><help:paragraphinfo state="U" number="60" xmlns:help="http://openoffice.org/2000/help"/>DIM PUBLIC VarName As TYPENAME</p>
  59.   <p class="Paragraph"><help:paragraphinfo state="U" number="61" xmlns:help="http://openoffice.org/2000/help"/>The variable is valid in all modules.</p>
  60.   <p class="PropText"><help:paragraphinfo state="U" number="62" xmlns:help="http://openoffice.org/2000/help"/>DIM PRIVATE VarName As TYPENAME</p>
  61.   <p class="Paragraph"><help:paragraphinfo state="U" number="63" xmlns:help="http://openoffice.org/2000/help"/>The variable is only valid in this module.</p>
  62.   <p class="PropText"><help:paragraphinfo state="U" number="64" xmlns:help="http://openoffice.org/2000/help"/>DIM VarName As TYPENAME</p>
  63.   <p class="Paragraph"><help:paragraphinfo state="U" number="65" xmlns:help="http://openoffice.org/2000/help"/>The variable is only valid in this module.</p>
  64.   <p class="Head3"><help:paragraphinfo state="U" number="66" xmlns:help="http://openoffice.org/2000/help"/>Saving Variable Content after Exiting a SUB or FUNCTION</p>
  65.   <p class="PropText"><help:paragraphinfo state="U" number="67" xmlns:help="http://openoffice.org/2000/help"/>DIM STATIC VarName As TYPENAME</p>
  66.   <p class="Paragraph"><help:paragraphinfo state="U" number="68" xmlns:help="http://openoffice.org/2000/help"/>The variable retains its value until the next time the FUNCTION or SUB is entered. The declaration must exist inseide a SUB or a FUNCTION.</p>
  67.   <p class="Head2"><help:paragraphinfo state="U" number="41" xmlns:help="http://openoffice.org/2000/help"/><help:key-word value="functions; return value type" tag="kw66513_2" xmlns:help="http://openoffice.org/2000/help"/>Specifying the Return Value Type of a FUNCTION</p>
  68.   <p class="Paragraph"><help:paragraphinfo state="U" number="42" xmlns:help="http://openoffice.org/2000/help"/>As with variables, include a type-declaration character after the function name, or the type indicated by "As" and the corresponding key word at the end of the parameter list to define the type of the function's return value, for example:</p>
  69.   <p class="PropText"><help:paragraphinfo state="U" number="43" xmlns:help="http://openoffice.org/2000/help"/>Function WordCount(WordText as String) <span class="T1">as Integer</span></p>
  70.  </body></html>